Inside Macintosh: Programming With the Text Encoding Conversion Manager /

Chapter 4 - Unicode Converter Reference / Unicode Converter Functions

Converting From Unicode /

CreateUnicodeToTextInfoByEncoding

Based on the given text encoding specification for the converted text, creates and returns a Unicode converter object containing information required for converting strings from Unicode to the specified non-Unicode encoding.

pascal OSStatus CreateUnicodeToTextInfoByEncoding (
      TextEncoding iEncoding,
      TextToUnicodeInfo *oUnicodeToTextInfo);

iEncoding

The text encoding specification for the destination, or converted, text.

oUnicodeToTextInfo

The Unicode converter object of type UnicodeToTextInfo (page 120) returned by the function.

function result

A result code. See "Text Encoding Conversion Manager Result Codes" (page 42) in the chapter "Basic Text Types Reference."

DISCUSSION

This function offers you an easier, alternative way to create a Unicode converter than the function CreateUnicodeToTextInfo (page 135). However, this method is less efficient internally because the destination text encoding you specify must be resolved into a Unicode mapping. Using this function, you cannot specify a version of Unicode, so a default version of Unicode is used; 16-bit format is assumed.

You pass a Unicode converter object returned from the function CreateUnicodeToTextInfoByEncoding to the function ConvertFromUnicodeToText (page 139) or ConvertFromUnicodeToPString (page 165) to identify the information to be used for the conversion. These two functions modify the contents of the Unicode converter object.

You pass a Unicode converter object returned from CreateUnicodeToTextInfoByEncoding to the function TruncateForUnicodeToText (page 162) to identify the information to be used to truncate the string. This function does not modify the contents of the Unicode converter object.

SEE ALSO

"Text Encoding Base" (page 31)